/* Copyright Statement:
 *
 * This software/firmware and related documentation ("AutoChips Software") are
 * protected under relevant copyright laws. The information contained herein is
 * confidential and proprietary to AutoChips Inc. and/or its licensors. Without
 * the prior written permission of AutoChips inc. and/or its licensors, any
 * reproduction, modification, use or disclosure of AutoChips Software, and
 * information contained herein, in whole or in part, shall be strictly
 * prohibited.
 *
 * AutoChips Inc. (C) 2020. All rights reserved.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("AUTOCHIPS SOFTWARE")
 * RECEIVED FROM AUTOCHIPS AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
 * ON AN "AS-IS" BASIS ONLY. AUTOCHIPS EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES AUTOCHIPS PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH THE AUTOCHIPS SOFTWARE, AND RECEIVER AGREES
 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN AUTOCHIPS
 * SOFTWARE. AUTOCHIPS SHALL ALSO NOT BE RESPONSIBLE FOR ANY AUTOCHIPS SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND AUTOCHIPS'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE AUTOCHIPS SOFTWARE
 * RELEASED HEREUNDER WILL BE, AT AUTOCHIPS'S OPTION, TO REVISE OR REPLACE THE
 * AUTOCHIPS SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
 * CHARGE PAID BY RECEIVER TO AUTOCHIPS FOR SUCH AUTOCHIPS SOFTWARE AT ISSUE.
 */

#ifndef _AC780X_RTC_H
#define _AC780X_RTC_H

/*!
 * @file ac780x_rtc.h
 *
 * @brief This file provides rtc integration functions interface.
 *
 */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* ============================================  Includes  ============================================ */
#include "ac7803x.h"

/* ============================================  Define  ============================================ */

/* ===========================================  Typedef  ============================================ */
/*!
 * @brief RTC clock source enumeration.
 */
typedef enum
{
    RTC_CLOCK_APB = 0x0U,         /*!< RTC APB clock source */
    RTC_CLOCK_LSI,                /*!< RTC internal 32k clock source */
    RTC_CLOCK_HSE,                /*!< RTC external XOSC clock source */
    RTC_CLOCK_LSE_PASSIVE,        /*!< RTC external RTCIn passive clock source */
    RTC_CLOCK_LSE_ACTIVE = 0x7U   /*!< RTC external RTCIn active clock source */
} RTC_ClockSourceType;

/*!
 * @brief RTC configuration structure.
 *
 * This structure holds the configuration settings for the RTC
 */
typedef struct
{
    ACTION_Type clockOutFlag;           /*!< RTC clock out source */
    RTC_ClockSourceType clockSource;    /*!< RTC clock source */
    uint32_t psrValue;                  /*!< RTC prescaler value */
    uint32_t alarmValue;                /*!< Alarm time value */
    uint32_t timeCnt;                   /*!< RTC real time counter value */
    ACTION_Type psrInterruptEn;         /*!< Enable/disable prescaler interrupt */
    ACTION_Type alarmInterruptEn;       /*!< Enable/disable rtc interrupt */
    ACTION_Type timeCntInterruptEn;               /*!< Enable/disable rtc cnt overflow output */
    DeviceCallback_Type callBack;       /*!< Callback function */
} RTC_ConfigType;

/* ==========================================  Variables  =========================================== */

/* ====================================  Functions declaration  ===================================== */
/*!
 * @brief Initialize RTC module.
 *
 * @param[in] config: RTC configuration pointer
 * @return none
 */
void RTC_Init(const RTC_ConfigType *config);

/*!
 * @brief RTC De-initialize.
 *
 * @param[in] none
 * @return none
 */
void RTC_DeInit(void);

/*!
 * @brief set callback func.
 *
 * @param[in] callback: callback func
 * @return none
 */
void RTC_SetCallback(DeviceCallback_Type callback);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _AC780X_RTC_H */

/* =============================================  EOF  ============================================== */
